Node / ReticulumProjects / Sideband.git / files / libs / able / docs / Makefile

Displaying Raw • Download

T8b949e# Makefile for Sphinx documentation

T8b949e#

T8b949e# You can set these variables from the command line.

Te6edf3SPHINXOPTS Tff7b72=

Te6edf3SPHINXBUILD Tff7b72= sphinx-build

Te6edf3PAPER Tff7b72=

Te6edf3BUILDDIR Tff7b72= _build

T8b949e# User-friendly check for sphinx-build

Tff7b72ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

Td2a8ff$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from httpTff7b72://Te6edf3sphinx-Te6edf3doc.Te6edf3org/)

Tff7b72endif

T8b949e# Internal variables.

Te6edf3PAPEROPT_a4 Tff7b72= -D Te6edf3latex_paper_sizeTff7b72=a4

Te6edf3PAPEROPT_letter Tff7b72= -D Te6edf3latex_paper_sizeTff7b72=letter

Te6edf3ALLSPHINXOPTS Tff7b72= -d Tff7b72$(BUILDDIRTff7b72)/doctrees Tff7b72$(PAPEROPT_Tff7b72$(PAPERTff7b72)Tff7b72) Tff7b72$(SPHINXOPTSTff7b72) .

T8b949e# the i18n builder cannot share the environment and doctrees with the others

Te6edf3I18NSPHINXOPTS Tff7b72= Tff7b72$(PAPEROPT_Tff7b72$(PAPERTff7b72)Tff7b72) Tff7b72$(SPHINXOPTSTff7b72) .

Td2a8ff.PHONYTff7b72: Te6edf3help Te6edf3clean Te6edf3html Te6edf3dirhtml Te6edf3singlehtml Te6edf3pickle Te6edf3json Te6edf3htmlhelp Te6edf3qthelp Te6edf3devhelp Te6edf3epub Te6edf3latex Te6edf3latexpdf Te6edf3text Te6edf3man Te6edf3changes Te6edf3linkcheck Te6edf3doctest Te6edf3gettext

Td2a8ffhelpTff7b72:

@echo Ta5d6ff"Please use \`make <target>' where <target> is one of"

@echo Ta5d6ff" html to make standalone HTML files"

@echo Ta5d6ff" dirhtml to make HTML files named index.html in directories"

@echo Ta5d6ff" singlehtml to make a single large HTML file"

@echo Ta5d6ff" pickle to make pickle files"

@echo Ta5d6ff" json to make JSON files"

@echo Ta5d6ff" htmlhelp to make HTML files and a HTML help project"

@echo Ta5d6ff" qthelp to make HTML files and a qthelp project"

@echo Ta5d6ff" devhelp to make HTML files and a Devhelp project"

@echo Ta5d6ff" epub to make an epub"

@echo Ta5d6ff" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"

@echo Ta5d6ff" latexpdf to make LaTeX files and run them through pdflatex"

@echo Ta5d6ff" latexpdfja to make LaTeX files and run them through platex/dvipdfmx"

@echo Ta5d6ff" text to make text files"

@echo Ta5d6ff" man to make manual pages"

@echo Ta5d6ff" texinfo to make Texinfo files"

@echo Ta5d6ff" info to make Texinfo files and run them through makeinfo"

@echo Ta5d6ff" gettext to make PO message catalogs"

@echo Ta5d6ff" changes to make an overview of all changed/added/deprecated items"

@echo Ta5d6ff" xml to make Docutils-native XML files"

@echo Ta5d6ff" pseudoxml to make pseudoxml-XML files for display purposes"

@echo Ta5d6ff" linkcheck to check all external links for integrity"

@echo Ta5d6ff" doctest to run all doctests embedded in the documentation (if enabled)"

Td2a8ffcleanTff7b72:

rm -rf Tff7b72$(BUILDDIRTff7b72)/*

Td2a8ffhtmlTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b html Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/html

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The HTML pages are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/html.Ta5d6ff"

Td2a8ffdirhtmlTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b dirhtml Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/dirhtml

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The HTML pages are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/dirhtml.Ta5d6ff"

Td2a8ffsinglehtmlTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b singlehtml Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/singlehtml

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The HTML page is in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/singlehtml.Ta5d6ff"

Td2a8ffpickleTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b pickle Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/pickle

@echo

@echo Ta5d6ff"Build finished; now you can process the pickle files."

Td2a8ffjsonTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b json Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/json

@echo

@echo Ta5d6ff"Build finished; now you can process the JSON files."

Td2a8ffhtmlhelpTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b htmlhelp Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/htmlhelp

@echo

@echo Ta5d6ff"Build finished; now you can run HTML Help Workshop with the" Tffea00\

Ta5d6ff"Ta5d6ff.hhp project file in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/htmlhelp.Ta5d6ff"

Td2a8ffqthelpTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b qthelp Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/qthelp

@echo

@echo Ta5d6ff"Build finished; now you can run "qcollectiongeneratorTa5d6ff" with the" Tffea00\

Ta5d6ff"Ta5d6ff.qhcp project file in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/qthelp, like this:Ta5d6ff"

@echo Ta5d6ff"Ta5d6ff# qcollectiongenerator Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/qthelp/ABLE.qhcpTa5d6ff"

@echo Ta5d6ff"To view the help file:"

@echo Ta5d6ff"Ta5d6ff# assistant -collectionFile Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/qthelp/ABLE.qhcTa5d6ff"

Td2a8ffdevhelpTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b devhelp Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/devhelp

@echo

@echo Ta5d6ff"Build finished."

@echo Ta5d6ff"To view the help file:"

@echo Ta5d6ff"Ta5d6ff# mkdir -p Te6edf3$$Ta5d6ffHOME/.local/share/devhelp/ABLETa5d6ff"

@echo Ta5d6ff"Ta5d6ff# ln -s Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/devhelp Te6edf3$$Ta5d6ffHOME/.local/share/devhelp/ABLETa5d6ff"

@echo Ta5d6ff"# devhelp"

Td2a8ffepubTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b epub Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/epub

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The epub file is in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/epub.Ta5d6ff"

Td2a8fflatexTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b latex Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/latex

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished; the LaTeX files are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/latex.Ta5d6ff"

@echo Ta5d6ff"Run \`make' in that directory to run these through (pdf)latex" Tffea00\

Ta5d6ff"(use \`make latexpdf' here to do that automatically)."

Td2a8fflatexpdfTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b latex Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/latex

@echo Ta5d6ff"Running LaTeX files through pdflatex..."

Tff7b72$(MAKETff7b72) -C Tff7b72$(BUILDDIRTff7b72)/latex all-pdf

@echo Ta5d6ff"Ta5d6ffpdflatex finished; the PDF files are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/latex.Ta5d6ff"

Td2a8fflatexpdfjaTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b latex Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/latex

@echo Ta5d6ff"Running LaTeX files through platex and dvipdfmx..."

Tff7b72$(MAKETff7b72) -C Tff7b72$(BUILDDIRTff7b72)/latex all-pdf-ja

@echo Ta5d6ff"Ta5d6ffpdflatex finished; the PDF files are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/latex.Ta5d6ff"

Td2a8fftextTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b text Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/text

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The text files are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/text.Ta5d6ff"

Td2a8ffmanTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b man Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/man

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The manual pages are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/man.Ta5d6ff"

Td2a8fftexinfoTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b texinfo Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/texinfo

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The Texinfo files are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/texinfo.Ta5d6ff"

@echo Ta5d6ff"Run \`make' in that directory to run these through makeinfo" Tffea00\

Ta5d6ff"(use \`make info' here to do that automatically)."

Td2a8ffinfoTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b texinfo Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/texinfo

@echo Ta5d6ff"Running Texinfo files through makeinfo..."

make -C Tff7b72$(BUILDDIRTff7b72)/texinfo info

@echo Ta5d6ff"Ta5d6ffmakeinfo finished; the Info files are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/texinfo.Ta5d6ff"

Td2a8ffgettextTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b gettext Tff7b72$(I18NSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/locale

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The message catalogs are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/locale.Ta5d6ff"

Td2a8ffchangesTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b changes Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/changes

@echo

@echo Ta5d6ff"Ta5d6ffThe overview file is in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/changes.Ta5d6ff"

Td2a8fflinkcheckTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b linkcheck Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/linkcheck

@echo

@echo Ta5d6ff"Link check complete; look for any errors in the above output " Tffea00\

Ta5d6ff"Ta5d6ffor in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/linkcheck/output.txt.Ta5d6ff"

Td2a8ffdoctestTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b doctest Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/doctest

@echo Ta5d6ff"Testing of doctests in the sources finished, look at the " Tffea00\

Ta5d6ff"Ta5d6ffresults in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/doctest/output.txt.Ta5d6ff"

Td2a8ffxmlTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b xml Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/xml

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The XML files are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/xml.Ta5d6ff"

Td2a8ffpseudoxmlTff7b72:

Tff7b72$(SPHINXBUILDTff7b72) -b pseudoxml Tff7b72$(ALLSPHINXOPTSTff7b72) Tff7b72$(BUILDDIRTff7b72)/pseudoxml

@echo

@echo Ta5d6ff"Ta5d6ffBuild finished. The pseudo-XML files are in Tff7b72$(BUILDDIRTff7b72)Ta5d6ff/pseudoxml.Ta5d6ff"